v0.0.25: Release 0.0.25

Compare Source

⏩ Upgrading

• 🧪 Test first on a branch 🏷️ by changing your workflow tags/references to this release
• See 🐣 Breaking Changes for how to adapt your workflow
• See 🐛 Known Issues for known issues

🐣 Breaking Changes

• Code Scanning action requires a Code Scanning Ruleset
  If you use SARIF reporting, then instead of the workflow yielding an ❌ when it fails, it will rely on github-advanced-security 🤖 to report the failure. You will need to adjust your checks for PRs.
  • If you are using use_sarif: ... and are using a ruleset, you'll want to change the value to use_sarif: 1 instead of a complicated rule, because otherwise github-advanced-security will only run sometimes and that will make PRs unmergable.
• Dropping support for on: schedule
• Dropping support for whitelist.txt and advice.txt
• Dropping support for out of tree project files
• Dependent actions are referenced by full sha instead of version -- if you're using Allow specified actions and reusable workflows, you will need to add:
  • check-spelling/checkout-merge@46bad523dcb6368efab50ff2729c00443785abca (if you run on: pull_request/on: pull_request_target and use with:/checkout: true)

✨ New Features

• Check submodules using submodules
• Provide instructions for when only_check_changed_files finds unrecognized words (#​86)
• Support unknown_file_word_limit to limit the number of times a path in a filename is reported when using check_file_names
• Suggest checkout: true for new missing-checkout error case
• Suggest ignoring files that trigger single-line-file

Dictionaries

• Fix fallback-dictionary-not-found handling

Hunspell dictionaries

• Fix support for .dic/.aff dictionaries by installing hunspell as needed (#​79 / #​90)
• Ensure that Spanish works (a consumer is using this, so it should work reliably)

Fixes

• macOS: Consistently use check-spelling dictionary instead of looking at the system dictionary (#​84)
• Fix check_for_newline_at_eof for allow.txt (#​81)
• Improve handling of inputs.ignored events
• Fix inputs.debug handling
• Fix merge instructions order
• Fix pattern for validating expect entries
• Fix noisy-file-list handling
• Fix 504 handling for only_check_changed_files when unshallowing
• Restore comment (#) support for expect files
• Include last character in token-is-substring warning

Improvements

• Line ending detection (#​83)
• RSQM handling
• Dictionary download times by skipping delays for 30x redirects
• Excludes paths generation
• Error handling of various components
• Documentation links
• GitHub error detection patterns for when check-spelling has bugs
• Handling of We'd

Messages

• Improve use of `s
  • Remove them from Line for candidate-pattern
  • Add them with better escaping for more user content
• Treat ignored-expect-variant as a warning

SARIF

• Switch to talking to /code-scanning/analysis directly
• Properly encode # in filenames (#​82)
• Stop trying to publish SARIF for commits from other repositories
• Use note severity for no-files-to-check
• Support defaultConfiguration.level when problem.severity is absent
• Add additional fields
• Only include used rules

Candidate patterns

• Suggest using # to suppress candidates (you can do this for forbidden patterns too, but this version won't suggest that)

Apply

• Improve error handling

Summary Tables

• List all present event classes at the top level
• Support cross repository pull requests

Checkout

• Suppress useless message about default branch
• Add failed checkout diagnostics
• Limit checkout credentials (#​91)

Testing

• Replace jd with Test::More::is_deeply
• Improve test suite and test coverage
• Work to consistently order output

Upgrade components

• checkout-merge@​v0.0.7
• gh-program-downloader@​v0.0.4

🐛 Known Issues

• If you use Allow specified actions and reusable workflows, if you run on: pull_request/on: pull_requesrt_target and use with:/checkout: true, you will need to allow check-spelling/checkout-merge@46bad523dcb6368efab50ff2729c00443785abca otherwise you will probably encounter:

  Error: Missing download info for check-spelling/checkout-merge@46bad523dcb6368efab50ff2729c00443785abca
  

• act as of v0.2.77 is not supported with checkout: true (there's a PR to act to fix this)
• check-spelling sometimes (e.g., for slow-file-list) won't correctly suggest disabling check_file_names:, instead, it will suggest excluding a file in /tmp/check-spelling/GITHUB_OWNER/REPOSITORY_NAME/paths-of-checked-files.txt (likely escaped)

Full Changelog

Full Changelog: check-spelling/check-spelling@v0.0.24...v0.0.25

v0.0.24: Release 0.0.24

Compare Source

⏩ Upgrading

• 🏷️ Test first on a branch by changing your workflow tags/references to this release. See 🐣 Breaking Changes for how to adapt your workflow.
• 🐛 See Known Issues for known issues

✨ Highlights

• SARIF reporting should work for push events and workflows that use checkout: true
• If you use a second job for commenting and the most recent comment was collapsed in response to a previous commit and the latest commit doesn't trigger a new comment, a new job will be not be dispatched
• Files with Mac OS classic line endings (\r) should be properly handled (previously they'd erroneously trigger a minified-file warning)

🐛 Known issues

Check the list of regressions with target milestone v0.0.25 for more information about issues that should be fixed soon.

• Hunspell dictionary (any extra dictionary that ends in .dic) support is broken https://github.com/check-spelling/check-spelling/issues/79
• expect files are corrupted when using ignore-pattern https://github.com/check-spelling/check-spelling/issues/80
• expect files with lines with comments (#) trigger errors -- note that automatic sorting moves the # lines to the top making them fairly useless so using comments isn't really recommended anyway.
• SARIF reporting will not report file names if the path to the file includes # https://github.com/check-spelling/check-spelling/issues/82
• Files with Windows line endings may not be properly detected if there's a line ending at bytes 4096/4097 of the file resulting in character offset reporting being shifted by +1 character https://github.com/check-spelling/check-spelling/issues/83
• Running the check-spelling action on Windows runners doesn't work
  • This appears to be an incompatibility involving StrawberryPerl, cpanm, and ExtUtils::Manifest
  • Note that running check-spelling on a GitHub hosted runner other than ubuntu-* doesn't really
    make sense as the Windows and macOS runners are much more expensive per minute and check-spelling
    itself doesn't need any facilities from the OS -- it should be checking the spelling of files
    as they are present in commits.
  • While the check-spelling action won't work on Windows, apply.pl and the output check-spelling produces are expected to work on Windows.

Full Changelog